home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 003 / litlbk21.arc / LITLBOOK.DOC < prev    next >
Text File  |  1986-10-07  |  19KB  |  444 lines
  1.           
  2.                                                                      
  3.  
  4.  
  5.  
  6.  
  7.          
  8.  
  9.  
  10.  
  11.                                   USERS MANUAL
  12.  
  13.  
  14.                                  
  15.                        ---------------------------------
  16.  
  17.                                   LITLBOOK.COM
  18.                                   
  19.                        ---------------------------------
  20.  
  21.                             An Address Book Database
  22.                               written by Kenn Flee
  23.                                        of
  24.                                Jamestown Software
  25.                             2508 Valley Forge Drive
  26.                                Madison WI  53719
  27.  
  28.                     Copyright (C)1986 by Jamestown Software
  29.  
  30.                                   Version 2.1
  31.                                 October 6, 1986
  32.  
  33.          
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.          Jamestown Software will not be liable for any damages, 
  41.          including any lost profits, lost savings or other incidental 
  42.          or consequential damages arising out of the use of or 
  43.          inability to use LITLBOOK.COM, even if Jamestown Software has 
  44.          been advised of the possibility of such damages, or for any 
  45.          claim by any other party.  
  46.  
  47.          LITLBOOK.COM is hereby released into the PUBLIC DOMAIN for 
  48.          non-commercial use by individuals and non-profit groups.  
  49.  
  50.          
  51.                                      Page 1
  52.  
  53.  
  54.          INTRODUCTION:
  55.  
  56.          LITLBOOK began as an example program to demonstrate the use 
  57.          of Borland's Database Toolbox at a meeting of the Madison 
  58.          Wisconsin PC User's Group -- Turbo Pascal Special Interest 
  59.          Group.  The original intent was to incorporate all the 
  60.          features of the Toolbox, including Sort.Box, in a relatively 
  61.          simple program that didn't "bury" the Toolbox routines too 
  62.          deeply.  After a couple of false starts that resulted in 
  63.          programs that were useful, but judged too complex to easily 
  64.          demonstrate, LITLBOOK evolved.  
  65.  
  66.          One change to traditional, simple "address book" programs has 
  67.          made LITLBOOK extremely useful.  Because with LITLBOOK you 
  68.          may assign each entry one of 30 "user-defined" classification 
  69.          codes plus include a "comment" line of 79 characters.  Thus 
  70.          you can maintain the equivalent of up to 30 different address 
  71.          lists all merged into one large database.  The reassignment 
  72.          of an entry's classification code effectively moves that 
  73.          entry from one "list" to another.  The reporting functions 
  74.          allow you to print both 1-up labels and general listings 
  75.          alphabetically, by classification, or by zip code.  
  76.  
  77.          With creative assignment of the classification code, you 
  78.          could maintain a list of group members by expiration month; 
  79.          primary and associate members of an organization; subscribers 
  80.          by renewal month; separate lists of friends, family, business 
  81.          associates and so on.  Yet when you "browse" the database, 
  82.          ALL records are returned in sorted order by last name/company 
  83.          name.  
  84.  
  85.  
  86.          FEATURES:
  87.  
  88.          * Written in Turbo Pascal (source code available).
  89.          * ISAM database with B+Tree structure.
  90.          * For floppy or harddisk systems.
  91.          * Menu-driven for ease of use.
  92.          * Allows assignment of entry to one of thirty classifications.
  93.          * Add, search, sort, edit and delete functions.
  94.          * Database file size limited only by floppy disk/hard disk 
  95.            size, or 32,760 records, whichever comes first.
  96.          * Finds and displays records very quickly.
  97.          * Released into the public domain.
  98.          
  99.          
  100.                                      Page 2
  101.  
  102.  
  103.          FILES INCLUDED:
  104.  
  105.          Just three: LITLBOOK.COM  The program file.
  106.                      LITLBOOK.DOC  This user's manual.
  107.                      MOVEBOOK.COM  Run to capture old LITLBOOK files
  108.                                    in new data file format
  109.  
  110.          The program will create additional files as needed:
  111.  
  112.                    LITLBOK2.DAT    The database main data file.
  113.                    LITLBOK2.IXN    The database main index file.
  114.                    LITLCLAS.DAT    The classifications data file.
  115.  
  116.          INSTALLATION:
  117.  
  118.          Floppy Disk Users:  Put original disk in drive A.
  119.                              Put blank, formatted disk in drive B.
  120.                              Copy LITLBOOK.COM (Copy A:LITLBOOK.COM B:).
  121.  
  122.            Hard Disk Users:  Make a subdirectory (MD \LITLBOOK).
  123.                              Change subdirectories (CD \LITLBOOK).
  124.                              Place original disk in drive A.
  125.                              Copy LITLBOOK files into subdirectory.
  126.                                   (Copy A:\LITLBOOK.*). -2 files-
  127.  
  128.          LITLBOOK will sense the existence of both color cards
  129.          and monochrome cards and adjust itself accordingly.
  130.  
  131.          
  132.          RUNNING LITLBOOK:
  133.  
  134.          Floppy Disk Users:  Be sure you see the "A>" prompt!  If you 
  135.                              don't, type A: and return.  Place your 
  136.                              LITLBOOK program disk in drive A.  Type 
  137.                              "LITLBOOK" and return.  
  138.  
  139.  
  140.          Hard Disk Users:  IMPORTANT: ALWAYS run LITLBOOK from the 
  141.                            subdirectory in which it resides!  (If you 
  142.                            don't, the program will create new data 
  143.                            files in your active subdirectory!)
  144.                            Type "LITLBOOK" and return.
  145.  
  146.          The first time you run LITLBOOK it will create and initialize 
  147.          new LITLBOOK.DAT, LITLBOOK.IXN and LITLCLAS.DAT files on your 
  148.          current disk or directory.
  149.  
  150.          NOTE: If you are upgrading from LITLBOOK v1.1, run MOVEBOOK
  151.                to capture your old data files.  LITLBOOK v2.0 now 
  152.                includes two phone number fields, whereas previous 
  153.                versions had only one.  
  154.          
  155.                                      Page 3
  156.  
  157.          THE MAIN MENU:
  158.  
  159.          After the data files have been initialized, the Main Menu 
  160.          will be displayed.  At the bottom left is the number of bytes 
  161.          left on your LITLBOOK drive/directory.  
  162.  
  163.          There are 4 choices listed in the main menu as follows:
  164.            
  165.                1 -- ADD new information
  166.                2 -- BROWSE/EDIT record information
  167.                3 -- PRINT record information / UTILITIES
  168.          
  169.                0 -- QUIT and return to DOS
  170.  
  171.          To select, press the number of the choice desired.  Each 
  172.          choice is described below.
  173.  
  174.  
  175.  
  176.          ADD NEW INFORMATION (Main Menu Choice 1):
  177.  
  178.          The data entry screen will be displayed.  Enter the 
  179.          information requested.  A "message" is displayed at the 
  180.          bottom of the screen to help you through the entries.
  181.  
  182.          Entry NOTES:
  183.          -----------------------------------------------------------
  184.          If you are entering a PERSON's name, put first name in the 
  185.          first name field and last name in the last name field.  If 
  186.          you are entering a COMPANY name, leave the first name field 
  187.          blank and put the company name in the last name field. 
  188.  
  189.          The zip code field is set up to allow for the new longer zip 
  190.          codes.
  191.  
  192.          Telephone area codes may entered in the format 123-456-7890.
  193.  
  194.          In the CLASS field, enter a number 1-30.  If you have already 
  195.          assigned a classification name for that number, it will be 
  196.          displayed.  If a name has not been assigned, all the assigned 
  197.          codes will be displayed and you may enter a new 
  198.          classification name.  If you wish to VIEW the assigned names, 
  199.          you may press <F1> and they will be displayed.
  200.  
  201.          On the comment line, you may press <Ctrl-D> to put today's 
  202.          date (from the system clock) into your comment line.
  203.  
  204.          
  205.                                      Page 4
  206.  
  207.          ADD NEW INFORMATION (continued):
  208.  
  209.          After completing the comment line (or after pressing <F10>) 
  210.          you will be asked if you wish to continue working with this 
  211.          record.  Press "Y" to edit it some more or "N" to continue.
  212.          If you press "N", you will asked if you wish to save the 
  213.          record.  Press "Y" to store it on disk, or "N" to continue 
  214.          without saving.  If you are entering NEW data, you will 
  215.          next be asked if you have another entry.  Press "Y" to add 
  216.          another record or "N" to return to the main menu.
  217.       
  218.  
  219.  
  220.          BROWSE/EDIT RECORD INFORMATION (Choice 2 in Main Menu):
  221.  
  222.          You will be asked to identify the last (or company) name to 
  223.          search for.  If you want to start at the beginning of the 
  224.          file, just press return.  (The files will always be displayed 
  225.          in alphabetical order by last name).  When any file is 
  226.          displayed, you may press: 
  227.  
  228.                     N -- Display next record
  229.                     P -- Display previous record
  230.                     S -- Enter new search name
  231.                     D -- Delete the record
  232.                     E -- Edit the record
  233.                     Q -- Quit and return to Main Menu
  234.  
  235.          NOTE: You may include your search string on the command line 
  236.          when invoking LB.COM and the program will skip the opening 
  237.          menu and immediately display your requested entry. 
  238.  
  239.  
  240.          PRINT RECORD INFORMATION / UTILITIES (Choice 3 in Main Menu): 
  241.                   
  242.          The Reports Menu will be displayed.  You may select any of 3 
  243.          different printed reports from the Reports Menu as described 
  244.          below.  You should set your printer type style and left 
  245.          margin before selecting your first printed listing.  DON'T 
  246.          set an automatic page length, because LITLBOOK automatically 
  247.          spaces over the perf (assuming a 11" page length).  
  248.  
  249.  
  250.          PRINT LABELS (Choice 4 in Report Menu)
  251.  
  252.          Will print 1-up labels in the following format:
  253.            +----------------------------------------+    ---
  254.            :                             Class #    :     :
  255.            : FirstName LastName                     :     :
  256.            : Address                                :     
  257.            : CityState  Zip                         :     6
  258.            :                                        :   Lines
  259.            +----------------------------------------+     :
  260.              :<----------35 characters--------->:         :
  261.            +----------------------------------------+    ---
  262.            :          ( next label )                : 
  263.          
  264.                                      Page 5 
  265.  
  266.          PRINT GENERAL LISTING (Choice 5 in Report Menu)
  267.  
  268.          Will print a narrative listing (* depending upon the other 
  269.          choices selected as described below) in the following format: 
  270.  
  271.          +----------------------------------------------------------+
  272.          :   Appropriate Header / Date                     Page #   :
  273.          :   ----------------------------------------------------   :
  274.          :                                                          :
  275.          :   F or LName* F or LName* ........................Phone  :
  276.          :      Address, CityState, Zip                             :
  277.          :      Comment                                             :
  278.          :         *Classification (if all classes selected)        :
  279.          :   F or LName* F or LName* ........................Phone  :
  280.          :      Address, CityState, Zip                             :
  281.          :      Comment                                             :
  282.          :         *Classification (if alpha sort selected)         :
  283.          :                                                          :
  284.          :                       -- etc. --                         :
  285.          :                                                          :
  286.                (sized to fit 8-1/2 x 11, skipping perforations)
  287.          
  288.          -------------------------------------------------------------
  289.          NOTE: After selecting report choices 4 or 5 you will be asked: 
  290.            
  291.            1. Sort Method:
  292.                 <A>lphabetically -- to print ALL records in 
  293.                                     alphabetical order.
  294.                 <C>lassification -- to print by classification.
  295.  
  296.            2. If printing labels:  Print in Zip Code order?  Yes/No
  297.  
  298.            3. If printing by classification: Print all?  Yes/No
  299.  
  300.            4. If NOT printing ALL classifications:  Which class?
  301.  
  302.            5. If choice 5 (general listing) selected:
  303.                 Print last name FIRST?  Yes/No
  304.                    (If YES, then last name printed in ALL CAPS, then a 
  305.                     comma, then last name; otherwise as originally 
  306.                     entered) 
  307.                 
  308.            6. <D>isk <S>creen or <P>rinter?
  309.                 If printer, then the program checks to see if the 
  310.                 printer is ready and requests that you align the
  311.                 paper to the top of the page.  Disk will create an 
  312.                 ascii text file on your current disk.
  313.  
  314.                 If disk is selected, you may choose from 4 formats:
  315.                 <P>rinter -- the same as when printed.
  316.                 <C>omma Delimited -- each field is separated by a 
  317.                      comma, with each record terminated with a 
  318.                      carriage return/line feed combination.
  319.                 <I>ndividual Lines -- each field on a line by itself.
  320.                 <F>ixed Length -- in columnar, "spreadsheet" style.
  321.           
  322.                                      Page 6
  323.                 
  324.                 This ascii file may be edited with a text editor or 
  325.                 wordprocessor, or imported into other databases.
  326.  
  327.            7. Printing may be paused by pressing any key, then "Y"
  328.                 to continue or "N" to return to menu.  
  329.  
  330.          ------------------------------------------------------------
  331.  
  332.          PRINT CLASSIFICATION SUMMARY (Choice 6 in Report Menu)
  333.  
  334.          Will print (printer only) your assigned classification names.  
  335.  
  336.          
  337.          CHANGE CLASSIFICATION NAME (Choice 7 in Report Menu)
  338.  
  339.          Select to view, change or add classification names.
  340.          
  341.          ------------------------------------------------------------
  342.  
  343.          TECHNICAL INFORMATION:
  344.  
  345.          If you wish to try to access the LITLBOOK.DAT data file, the 
  346.          following describes the record definition. NOTE: actual data 
  347.          begins in record 1 (record 0 is reserved for program use).  
  348.  
  349.            LITLBOOK.DAT (Toolbox DataFile)
  350.            ---------------------------------------------------------
  351.            Status    : Integer     { 0=Active  All Else=Deleted }
  352.            FName     : String[15]  { First Name }
  353.            LName     : String[30]  { Last or Company Name }
  354.            Address   : String[25]  { Street Address }
  355.            CityState : String[25]  { City and State }
  356.            Zip       : String[10]  { Zip Code }
  357.            Phone1    : String[12]  { Phone Number One}
  358.            Phone2    : String[12]  { Phone Number Two}
  359.            Class     : String[2]   { Classification NUMBER 0-30 }
  360.            Comment   : String[79]  { Comment Line }
  361.  
  362.            LITLBOOK.IXN (Toolbox IndexFile)
  363.            ---------------------------------------------------------
  364.            Key is String[15], duplicates allowed
  365.  
  366.            LITLCLAS.DAT (Turbo Typed File of String[35])
  367.            ---------------------------------------------------------
  368.            Array[1..30] of String[35]  (Classification names)
  369.            
  370.          Each datafile record is 221 bytes in length with 1 record 
  371.          overhead.  Each index key is 15 bytes in length.  
  372.          LITLBOOK.COM is written in Turbo Pascal using the Database 
  373.          Toolbox, both by Borland International.  Requires DOS2.x or 
  374.          greater.  Written on an IBM-PC with a color monitor, but 
  375.          should run on close compatibles with monochrome monitors.  
  376.          Probably should have 256K for reasonably fast processing 
  377.          (program uses as much normal memory as available for sorting 
  378.          and B+Tree storage, with disk used for overflow).  
  379.          
  380.                                      Page 7
  381.  
  382.  
  383.          If you request source code, please note that you must have 
  384.          Turbo Pascal 3.0+ and the Turbo DataBase Toolbox to modify 
  385.          the program.  Necessary "include" files are declared in the 
  386.          program, but the files themselves must come from you.  
  387.  
  388.          
  389.          USER-SUPPORTED SOFTWARE (Shareware) / Source Code:
  390.  
  391.          You are free to copy this program and share it with others. 
  392.          If you find it to be of value I would appreciate your 
  393.          monetary support of $5-$10.  If you send $10 or more, I will 
  394.          send you a diskette containing the source code for LITLBOOK, 
  395.          plus the latest version of FILECAT--the file cataloging 
  396.          database that helps you keep track of the hundreds or 
  397.          thousands of files you have on your diskettes or hard drive 
  398.          through the use of keywords and 300+ character descriptions.  
  399.  
  400.          In any case let me know if you like LITLBOOK... what 
  401.          improvements you would like... what you hate... to say hello.  
  402.                   
  403.          Send your support/source code requests and comments to:
  404.  
  405.                                    Kenn Flee
  406.                                Jamestown Software
  407.                             2508 Valley Forge Drive
  408.                                Madison WI  53719
  409.                 
  410.                               Compuserve 74275,745
  411.                                BBS: 608-251-7734
  412.                    (24 hour, 300-1200-2400, 8-N-1, no nulls)
  413.  
  414.          
  415.          REVISION HISTORY:
  416.  
  417.          05/21/86 -- Preliminary "meeting" release, version 1.0.
  418.  
  419.          05/24/86 -- Classification file read-write problem corrected.  
  420.          Version     Enhancements added to sort options.
  421.          1.1         Improvements made to printed reports.
  422.  
  423.          09/07/86 -- Added second phone number field.
  424.          Version     Added ascii text disk file option to reports.
  425.          2.0         MOVEBOOK included to capture old data file.
  426.  
  427.          10/06/86 -- Added Command line search string option to 
  428.          Version     allow LB.COM to be called by QFILER.  
  429.          2.1         (Program must be named LB.COM for QFILER use).
  430.          
  431.                                      Page 8
  432.  
  433.                  
  434.  
  435.          ABOUT THE AUTHOR:
  436.  
  437.          Kenn Flee is an independent applications programmer and 
  438.          consultant specializing in dedicated database applications 
  439.          and typesetting telecommunications.  Popular user-supported 
  440.          files by Jamestown Software include QFILER, a file manager, 
  441.          and FILECAT, a disk cataloging utility. 
  442.          
  443.  
  444.